<!DOCTYPE html>
<html lang="zh-CN">
<head>
  <meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=2">
<meta name="theme-color" content="#222">
<meta name="generator" content="Hexo 5.4.2">
  <link rel="apple-touch-icon" sizes="180x180" href="/images/apple-touch-icon-next.png">
  <link rel="icon" type="image/png" sizes="32x32" href="/images/favicon-32x32-next.png">
  <link rel="icon" type="image/png" sizes="16x16" href="/images/favicon-16x16-next.png">
  <link rel="mask-icon" href="/images/logo.svg" color="#222">

<link rel="stylesheet" href="/css/main.css">


<link rel="stylesheet" href="/lib/font-awesome/css/all.min.css">

<script id="hexo-configurations">
    var NexT = window.NexT || {};
    var CONFIG = {"hostname":"wrr123.github.io","root":"/","scheme":"Muse","version":"7.8.0","exturl":false,"sidebar":{"position":"left","display":"post","padding":18,"offset":12,"onmobile":false},"copycode":{"enable":false,"show_result":false,"style":null},"back2top":{"enable":true,"sidebar":false,"scrollpercent":false},"bookmark":{"enable":false,"color":"#222","save":"auto"},"fancybox":false,"mediumzoom":false,"lazyload":false,"pangu":false,"comments":{"style":"tabs","active":null,"storage":true,"lazyload":false,"nav":null},"algolia":{"hits":{"per_page":10},"labels":{"input_placeholder":"Search for Posts","hits_empty":"We didn't find any results for the search: ${query}","hits_stats":"${hits} results found in ${time} ms"}},"localsearch":{"enable":true,"trigger":"auto","top_n_per_article":1,"unescape":false,"preload":false},"motion":{"enable":true,"async":false,"transition":{"post_block":"fadeIn","post_header":"slideDownIn","post_body":"slideDownIn","coll_header":"slideLeftIn","sidebar":"slideUpIn"}},"path":"search.json"};
  </script>

  <meta name="description" content="错误码1. 【强制】 错误码的制定原则：快速溯源、沟通标准化。说明： 错误码想得过于完美和复杂，就像康熙字典中的生僻字一样，用词似乎精准，但是字典不容易随身携带并且简单易懂。 正例： 错误码回答的问题是谁的错？错在哪？  错误码必须能够快速知晓错误来源，可快速判断是谁的问题。 错误码必须能够进行清晰得比对（代码中容易 equals）。 错误码有利于团队快速对错误原因达到一致认知。  2. 【强制】">
<meta property="og:type" content="article">
<meta property="og:title" content="java开发手册-异常日志">
<meta property="og:url" content="https://wrr123.github.io/2021/01/20/java%E5%BC%80%E5%8F%91%E6%89%8B%E5%86%8C-%E5%BC%82%E5%B8%B8%E6%97%A5%E5%BF%97/index.html">
<meta property="og:site_name" content="一缕烟气">
<meta property="og:description" content="错误码1. 【强制】 错误码的制定原则：快速溯源、沟通标准化。说明： 错误码想得过于完美和复杂，就像康熙字典中的生僻字一样，用词似乎精准，但是字典不容易随身携带并且简单易懂。 正例： 错误码回答的问题是谁的错？错在哪？  错误码必须能够快速知晓错误来源，可快速判断是谁的问题。 错误码必须能够进行清晰得比对（代码中容易 equals）。 错误码有利于团队快速对错误原因达到一致认知。  2. 【强制】">
<meta property="og:locale" content="zh_CN">
<meta property="article:published_time" content="2021-01-20T01:49:55.000Z">
<meta property="article:modified_time" content="2022-02-18T02:52:04.451Z">
<meta property="article:author" content="田园隐士">
<meta property="article:tag" content="java">
<meta name="twitter:card" content="summary">

<link rel="canonical" href="https://wrr123.github.io/2021/01/20/java%E5%BC%80%E5%8F%91%E6%89%8B%E5%86%8C-%E5%BC%82%E5%B8%B8%E6%97%A5%E5%BF%97/">


<script id="page-configurations">
  // https://hexo.io/docs/variables.html
  CONFIG.page = {
    sidebar: "",
    isHome : false,
    isPost : true,
    lang   : 'zh-CN'
  };
</script>

  <title>java开发手册-异常日志 | 一缕烟气</title>
  






  <noscript>
  <style>
  .use-motion .brand,
  .use-motion .menu-item,
  .sidebar-inner,
  .use-motion .post-block,
  .use-motion .pagination,
  .use-motion .comments,
  .use-motion .post-header,
  .use-motion .post-body,
  .use-motion .collection-header { opacity: initial; }

  .use-motion .site-title,
  .use-motion .site-subtitle {
    opacity: initial;
    top: initial;
  }

  .use-motion .logo-line-before i { left: initial; }
  .use-motion .logo-line-after i { right: initial; }
  </style>
</noscript>

<link rel="alternate" href="/atom.xml" title="一缕烟气" type="application/atom+xml">
</head>

<body itemscope itemtype="http://schema.org/WebPage">
  <div class="container use-motion">
    <div class="headband"></div>

    <header class="header" itemscope itemtype="http://schema.org/WPHeader">
      <div class="header-inner"><div class="site-brand-container">
  <div class="site-nav-toggle">
    <div class="toggle" aria-label="切换导航栏">
      <span class="toggle-line toggle-line-first"></span>
      <span class="toggle-line toggle-line-middle"></span>
      <span class="toggle-line toggle-line-last"></span>
    </div>
  </div>

  <div class="site-meta">

    <a href="/" class="brand" rel="start">
      <span class="logo-line-before"><i></i></span>
      <h1 class="site-title">一缕烟气</h1>
      <span class="logo-line-after"><i></i></span>
    </a>
      <p class="site-subtitle" itemprop="description">沧海月明珠有泪，蓝田日暖玉生烟</p>
  </div>

  <div class="site-nav-right">
    <div class="toggle popup-trigger">
        <i class="fa fa-search fa-fw fa-lg"></i>
    </div>
  </div>
</div>




<nav class="site-nav">
  <ul id="menu" class="main-menu menu">
        <li class="menu-item menu-item-home">

    <a href="/" rel="section"><i class="fa fa-home fa-fw"></i>首页</a>

  </li>
        <li class="menu-item menu-item-archives">

    <a href="/archives/" rel="section"><i class="fa fa-archive fa-fw"></i>归档</a>

  </li>
      <li class="menu-item menu-item-search">
        <a role="button" class="popup-trigger"><i class="fa fa-search fa-fw"></i>搜索
        </a>
      </li>
  </ul>
</nav>



  <div class="search-pop-overlay">
    <div class="popup search-popup">
        <div class="search-header">
  <span class="search-icon">
    <i class="fa fa-search"></i>
  </span>
  <div class="search-input-container">
    <input autocomplete="off" autocapitalize="off"
           placeholder="搜索..." spellcheck="false"
           type="search" class="search-input">
  </div>
  <span class="popup-btn-close">
    <i class="fa fa-times-circle"></i>
  </span>
</div>
<div id="search-result">
  <div id="no-result">
    <i class="fa fa-spinner fa-pulse fa-5x fa-fw"></i>
  </div>
</div>

    </div>
  </div>

</div>
    </header>

    
  <div class="back-to-top">
    <i class="fa fa-arrow-up"></i>
    <span>0%</span>
  </div>


    <main class="main">
      <div class="main-inner">
        <div class="content-wrap">
          

          <div class="content post posts-expand">
            

    
  
  
  <article itemscope itemtype="http://schema.org/Article" class="post-block" lang="zh-CN">
    <link itemprop="mainEntityOfPage" href="https://wrr123.github.io/2021/01/20/java%E5%BC%80%E5%8F%91%E6%89%8B%E5%86%8C-%E5%BC%82%E5%B8%B8%E6%97%A5%E5%BF%97/">

    <span hidden itemprop="author" itemscope itemtype="http://schema.org/Person">
      <meta itemprop="image" content="/images/avatar.gif">
      <meta itemprop="name" content="田园隐士">
      <meta itemprop="description" content="talk is cheap, show me the code">
    </span>

    <span hidden itemprop="publisher" itemscope itemtype="http://schema.org/Organization">
      <meta itemprop="name" content="一缕烟气">
    </span>
      <header class="post-header">
        <h1 class="post-title" itemprop="name headline">
          java开发手册-异常日志
        </h1>

        <div class="post-meta">
            <span class="post-meta-item">
              <span class="post-meta-item-icon">
                <i class="far fa-calendar"></i>
              </span>
              <span class="post-meta-item-text">发表于</span>

              <time title="创建时间：2021-01-20 09:49:55" itemprop="dateCreated datePublished" datetime="2021-01-20T09:49:55+08:00">2021-01-20</time>
            </span>
              <span class="post-meta-item">
                <span class="post-meta-item-icon">
                  <i class="far fa-calendar-check"></i>
                </span>
                <span class="post-meta-item-text">更新于</span>
                <time title="修改时间：2022-02-18 10:52:04" itemprop="dateModified" datetime="2022-02-18T10:52:04+08:00">2022-02-18</time>
              </span>

          
            <span class="post-meta-item" title="阅读次数" id="busuanzi_container_page_pv" style="display: none;">
              <span class="post-meta-item-icon">
                <i class="fa fa-eye"></i>
              </span>
              <span class="post-meta-item-text">阅读次数：</span>
              <span id="busuanzi_value_page_pv"></span>
            </span><br>
            <span class="post-meta-item" title="本文字数">
              <span class="post-meta-item-icon">
                <i class="far fa-file-word"></i>
              </span>
                <span class="post-meta-item-text">本文字数：</span>
              <span>3.8k</span>
            </span>
            <span class="post-meta-item" title="阅读时长">
              <span class="post-meta-item-icon">
                <i class="far fa-clock"></i>
              </span>
                <span class="post-meta-item-text">阅读时长 &asymp;</span>
              <span>3 分钟</span>
            </span>

        </div>
      </header>

    
    
    
    <div class="post-body" itemprop="articleBody">

      
        <h4 id="错误码"><a href="#错误码" class="headerlink" title="错误码"></a>错误码</h4><h5 id="1-【强制】-错误码的制定原则：快速溯源、沟通标准化。"><a href="#1-【强制】-错误码的制定原则：快速溯源、沟通标准化。" class="headerlink" title="1. 【强制】 错误码的制定原则：快速溯源、沟通标准化。"></a>1. <span style="color:brown">【强制】</span> 错误码的制定原则：快速溯源、沟通标准化。</h5><p><span style="color:sienna;">说明：</span> 错误码想得过于完美和复杂，就像康熙字典中的生僻字一样，用词似乎精准，但是字典不容易随身携带并且简单易懂。</p>
<p><span style="color:green;">正例：</span> 错误码回答的问题是谁的错？错在哪？</p>
<ol>
<li>错误码必须能够快速知晓错误来源，可快速判断是谁的问题。</li>
<li>错误码必须能够进行清晰得比对（代码中容易 <code>equals</code>）。</li>
<li>错误码有利于团队快速对错误原因达到一致认知。</li>
</ol>
<h5 id="2-【强制】-错误码不体现版本号和错误等级信息。"><a href="#2-【强制】-错误码不体现版本号和错误等级信息。" class="headerlink" title="2. 【强制】 错误码不体现版本号和错误等级信息。"></a>2. <span style="color:brown;">【强制】</span> 错误码不体现版本号和错误等级信息。</h5><span id="more"></span>
<p><span style="color:sienna;">说明：</span> 错误码以不断追加地方式进行兼容。错误等级由日志和错误码本身的释义来决定。</p>
<h5 id="3-【强制】-全部正常，但不得不填充错误码时返回五个零：00000。"><a href="#3-【强制】-全部正常，但不得不填充错误码时返回五个零：00000。" class="headerlink" title="3. 【强制】 全部正常，但不得不填充错误码时返回五个零：00000。"></a>3. <span style="color:brown;">【强制】</span> 全部正常，但不得不填充错误码时返回五个零：<code>00000</code>。</h5><h5 id="4-【强制】-错误码为字符串类型，共-5-位，分成两个部分：错误产生来源-四位数字编号。"><a href="#4-【强制】-错误码为字符串类型，共-5-位，分成两个部分：错误产生来源-四位数字编号。" class="headerlink" title="4. 【强制】 错误码为字符串类型，共 5 位，分成两个部分：错误产生来源 + 四位数字编号。"></a>4. <span style="color:brown;">【强制】</span> 错误码为字符串类型，共 5 位，分成两个部分：错误产生来源 + 四位数字编号。</h5><p><span style="color:sienna;">说明：</span> 错误产生来源为<code>A/B/C</code>，<code>A</code> 表示错误来源于用户，比如参数错误、用户安装版本过低、用户支付超时等问题；<code>B</code> 表示错误来源于当前系统，往往是业务逻辑出错，或程序健壮性差等问题；<code>C</code> 表示错误来源于第三方服务，比如 <code>CDN</code> 服务出错，消息投递超时等问题；四位数字编号从 <code>0001</code> 到 <code>9999</code>，大类之间的步长间距预留 <code>100</code>。</p>
<h5 id="5-【强制】-编号不与公司业务架构，更不与组织架构挂钩，以先到先得的原则在统一平台上进行，审批生效，编号即被永久固定。"><a href="#5-【强制】-编号不与公司业务架构，更不与组织架构挂钩，以先到先得的原则在统一平台上进行，审批生效，编号即被永久固定。" class="headerlink" title="5. 【强制】 编号不与公司业务架构，更不与组织架构挂钩，以先到先得的原则在统一平台上进行，审批生效，编号即被永久固定。"></a>5. <span style="color:brown;">【强制】</span> 编号不与公司业务架构，更不与组织架构挂钩，以先到先得的原则在统一平台上进行，审批生效，编号即被永久固定。</h5><h5 id="6-【强制】-错误码使用者避免随意定义新的错误码。"><a href="#6-【强制】-错误码使用者避免随意定义新的错误码。" class="headerlink" title="6. 【强制】 错误码使用者避免随意定义新的错误码。"></a>6. <span style="color:brown;">【强制】</span> 错误码使用者避免随意定义新的错误码。</h5><p><span style="color:sienna;">说明：</span> 尽可能在原有错误码附表中找到语义相同或者相近的错误码在代码中使用即可。</p>
<h5 id="7-【强制】-错误码不能直接输出给用户作为提示信息使用。"><a href="#7-【强制】-错误码不能直接输出给用户作为提示信息使用。" class="headerlink" title="7. 【强制】 错误码不能直接输出给用户作为提示信息使用。"></a>7. <span style="color:brown;">【强制】</span> 错误码不能直接输出给用户作为提示信息使用。</h5><p><span style="color:sienna;">说明：</span> 堆栈（stack_trace）、错误信息（error_message）、错误码（error_code）、提示信息（user_tip）是一个有效关联并互相转义的和谐整体，但是请勿互相越俎代庖。</p>
<h5 id="8-【推荐】-错误码之外的业务独特信息由error-message-来承载，而不是让错误本身涵盖过多具体业务属性。"><a href="#8-【推荐】-错误码之外的业务独特信息由error-message-来承载，而不是让错误本身涵盖过多具体业务属性。" class="headerlink" title="8. 【推荐】 错误码之外的业务独特信息由error_message 来承载，而不是让错误本身涵盖过多具体业务属性。"></a>8. <span style="color:orange;">【推荐】</span> 错误码之外的业务独特信息由<code>error_message</code> 来承载，而不是让错误本身涵盖过多具体业务属性。</h5><h5 id="9-【推荐】-在获取第三方服务错误时，向上抛出允许本系统转义，由-C-转为-B，并且在错误信息上带上原有的第三方错误码。"><a href="#9-【推荐】-在获取第三方服务错误时，向上抛出允许本系统转义，由-C-转为-B，并且在错误信息上带上原有的第三方错误码。" class="headerlink" title="9. 【推荐】 在获取第三方服务错误时，向上抛出允许本系统转义，由 C 转为 B，并且在错误信息上带上原有的第三方错误码。"></a>9. <span style="color:orange;">【推荐】</span> 在获取第三方服务错误时，向上抛出允许本系统转义，由 <code>C</code> 转为 <code>B</code>，并且在错误信息上带上原有的第三方错误码。</h5><h5 id="10-【参考】-错误码分为一级宏观错误码、二级宏观错误码、三级宏观错误码。"><a href="#10-【参考】-错误码分为一级宏观错误码、二级宏观错误码、三级宏观错误码。" class="headerlink" title="10. 【参考】 错误码分为一级宏观错误码、二级宏观错误码、三级宏观错误码。"></a>10. <span style="color:green;">【参考】</span> 错误码分为一级宏观错误码、二级宏观错误码、三级宏观错误码。</h5><p><span style="color:sienna;">说明：</span> 在无法更加具体确定的错误场景中，可以直接使用一级宏观错误码，分别是：<strong>A0001</strong>(用户端错误)、<strong>B0001</strong>(系统执行出错)、<strong>C0001</strong>(调用第三方服务错误)。</p>
<p><span style="color:green;">正例：</span> 调用第三方服务出错时一级、中间件错误是二级、消息服务出错是三级。</p>
<h5 id="11-【参考】-错误码的后三位编码与-HTTP-状态码没有任何关系。"><a href="#11-【参考】-错误码的后三位编码与-HTTP-状态码没有任何关系。" class="headerlink" title="11. 【参考】 错误码的后三位编码与 HTTP 状态码没有任何关系。"></a>11. <span style="color:green;">【参考】</span> 错误码的后三位编码与 <code>HTTP</code> 状态码没有任何关系。</h5><h5 id="12-【参考】-错误码有利于不同文化背景的开发者进行交流与代码协作。"><a href="#12-【参考】-错误码有利于不同文化背景的开发者进行交流与代码协作。" class="headerlink" title="12. 【参考】 错误码有利于不同文化背景的开发者进行交流与代码协作。"></a>12. <span style="color:green;">【参考】</span> 错误码有利于不同文化背景的开发者进行交流与代码协作。</h5><p><span style="color:sienna;">说明：</span> 英文单词形式的错误码不利于非英语母语国家（如阿拉伯语、希伯来语、俄罗斯语等）之间的开发者互相协作。</p>
<h5 id="13-【参考】-错误码即人性，感性认知-口口相传，使用纯数字来进行错误码编排不利于感性记忆和分类。"><a href="#13-【参考】-错误码即人性，感性认知-口口相传，使用纯数字来进行错误码编排不利于感性记忆和分类。" class="headerlink" title="13. 【参考】 错误码即人性，感性认知 + 口口相传，使用纯数字来进行错误码编排不利于感性记忆和分类。"></a>13. <span style="color:green;">【参考】</span> 错误码即人性，感性认知 + 口口相传，使用纯数字来进行错误码编排不利于感性记忆和分类。</h5><p><span style="color:sienna;">说明：</span> 数字是一个整体，每位数字的地位和含义是相同的。</p>
<p><span style="color:red;">反例：</span> 一个五位数字 <code>12345</code>，第 <code>1</code> 位是错误等级，第 <code>2</code> 位是错误来源，<code>345</code> 是编号，人的大脑不会主动地拆开并分辨每位数字地不同含义。</p>
<h4 id="日志规约"><a href="#日志规约" class="headerlink" title="日志规约"></a>日志规约</h4><h5 id="1-【强制】-应用中不可直接使用日志系统（Log4j、Logback）中的-API，而应依赖使用日志框架（SLF4J、JCL—Jakarta-Commons-Logging）中的-API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。"><a href="#1-【强制】-应用中不可直接使用日志系统（Log4j、Logback）中的-API，而应依赖使用日志框架（SLF4J、JCL—Jakarta-Commons-Logging）中的-API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。" class="headerlink" title="1. 【强制】 应用中不可直接使用日志系统（Log4j、Logback）中的 API，而应依赖使用日志框架（SLF4J、JCL—Jakarta Commons Logging）中的 API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。"></a>1. <span style="color:brown;">【强制】</span> 应用中不可直接使用日志系统（Log4j、Logback）中的 <code>API</code>，而应依赖使用日志框架（SLF4J、JCL—Jakarta Commons Logging）中的 <code>API</code>，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。</h5><p><span style="color:sienna;">说明：</span> 日志框架（SLF4J、JCL-Jakarta Commons Logging）的使用方式（推荐使用 SLF4J）</p>
<p>使用 <code>SLF4J</code>:</p>
<figure class="highlight java"><table><tr><td class="gutter"><pre><span class="line">1</span><br><span class="line">2</span><br><span class="line">3</span><br></pre></td><td class="code"><pre><span class="line"><span class="keyword">import</span> org.slf4j.Logger;</span><br><span class="line"><span class="keyword">import</span> org.slf4j.LoggerFactory;</span><br><span class="line"><span class="keyword">private</span> <span class="keyword">static</span> <span class="keyword">final</span> <span class="type">Logger</span> <span class="variable">logger</span> <span class="operator">=</span> LoggerFactory.getLogger(Test.class);</span><br></pre></td></tr></table></figure>
<p>使用 <code>JCL</code>：</p>
<figure class="highlight java"><table><tr><td class="gutter"><pre><span class="line">1</span><br><span class="line">2</span><br><span class="line">3</span><br></pre></td><td class="code"><pre><span class="line"><span class="keyword">import</span> org.apache.commons.logging.Log;</span><br><span class="line"><span class="keyword">import</span> org.apache.commons.logging.LogFactory;</span><br><span class="line"><span class="keyword">private</span> <span class="keyword">static</span> <span class="keyword">final</span> <span class="type">Log</span> <span class="variable">log</span> <span class="operator">=</span> LogFactory.getLog(Test.class);</span><br></pre></td></tr></table></figure>
<h5 id="2-【强制】-所有日志文件至少保存-15-天，因为有些异常具备以-周-为频次发生的特点。对于当天日志，以-应用名-log-来保存，保存在-home-admin-应用名-logs-目录下，过往日志格式为-logname-log-保存日期-，日期格式：yyyy-MM-dd"><a href="#2-【强制】-所有日志文件至少保存-15-天，因为有些异常具备以-周-为频次发生的特点。对于当天日志，以-应用名-log-来保存，保存在-home-admin-应用名-logs-目录下，过往日志格式为-logname-log-保存日期-，日期格式：yyyy-MM-dd" class="headerlink" title="2. 【强制】 所有日志文件至少保存 15 天，因为有些异常具备以 周  为频次发生的特点。对于当天日志，以 应用名.log 来保存，保存在 /home/admin/应用名/logs/ 目录下，过往日志格式为: {logname}.log.{保存日期}，日期格式：yyyy-MM-dd"></a>2. <span style="color:brown;">【强制】</span> 所有日志文件至少保存 15 天，因为有些异常具备以 <code>周</code>  为频次发生的特点。对于当天日志，以 <code>应用名.log</code> 来保存，保存在 <code>/home/admin/应用名/logs/</code> 目录下，过往日志格式为: <code>&#123;logname&#125;.log.&#123;保存日期&#125;</code>，日期格式：<code>yyyy-MM-dd</code></h5><p><span style="color:green;">正例：</span> 以 <code>app</code> 应用为例，日志保存在 <code>/home/admin/appserver/logs/app.log</code>，历史日志名称为 <code>app.log.2017-12-01</code>。</p>
<h5 id="3-【强制】-根据国家法律，网络运行状态、网络安全事件、个人敏感信息操作等相关记录，留存的日志不少于六个月，并且进行网络多机备份。"><a href="#3-【强制】-根据国家法律，网络运行状态、网络安全事件、个人敏感信息操作等相关记录，留存的日志不少于六个月，并且进行网络多机备份。" class="headerlink" title="3. 【强制】 根据国家法律，网络运行状态、网络安全事件、个人敏感信息操作等相关记录，留存的日志不少于六个月，并且进行网络多机备份。"></a>3. <span style="color:brown;">【强制】</span> 根据国家法律，网络运行状态、网络安全事件、个人敏感信息操作等相关记录，留存的日志不少于六个月，并且进行网络多机备份。</h5><h5 id="4-【强制】-应用中的扩展日志（如打点、临时监控、访问日志等）命名方式：appName-logType-logName-log"><a href="#4-【强制】-应用中的扩展日志（如打点、临时监控、访问日志等）命名方式：appName-logType-logName-log" class="headerlink" title="4. 【强制】 应用中的扩展日志（如打点、临时监控、访问日志等）命名方式：appName_logType_logName.log."></a>4. <span style="color:brown;">【强制】</span> 应用中的扩展日志（如打点、临时监控、访问日志等）命名方式：<code>appName_logType_logName.log</code>.</h5><ul>
<li><code>logType</code>: 日志类型，如 <code>stats/monitor/access</code>等</li>
<li><code>logName</code>: 日志描述。</li>
</ul>
<p>这种命名的好处：通过文件就可以知道日志文件属于什么应用、什么类型、什么目的，也有利于归类查找。</p>
<p><span style="color:sienna;">说明：</span> 推荐对日志进行分类，如将错误日志和业务日志分开存放，便于开发人员查看，也便于通过日志对系统进行及时监控。</p>
<p><span style="color:green;">正例：</span> <code>mppserver</code> 应用中单独监控时区转换异常，如：<code>mppserver_monitor_timeZoneConvert.log</code>。</p>
<h5 id="5-【强制】-在日志输出时，字符串变量之间的拼接使用占位符的方式。"><a href="#5-【强制】-在日志输出时，字符串变量之间的拼接使用占位符的方式。" class="headerlink" title="5. 【强制】 在日志输出时，字符串变量之间的拼接使用占位符的方式。"></a>5. <span style="color:brown;">【强制】</span> 在日志输出时，字符串变量之间的拼接使用占位符的方式。</h5><p><span style="color:sienna;">说明：</span> 因为 <code>String</code> 字符串的拼接会使用 <code>StringBuilder</code> 的 <code>append()</code> 方式，有一定的性能损耗。使用占位符仅是替换动作，可以有效提升性能。</p>
<p><span style="color:green;">正例：</span> <code>logger.debug(&quot;Processing trade with id: &#123;&#125; and symbol: &#123;&#125;&quot;, id, symbol);</code></p>
<h5 id="6-【强制】-对于-trace-debug-info-级别的日志输出，必须进行日志级别的开关判断。"><a href="#6-【强制】-对于-trace-debug-info-级别的日志输出，必须进行日志级别的开关判断。" class="headerlink" title="6. 【强制】 对于 trace/debug/info 级别的日志输出，必须进行日志级别的开关判断。"></a>6. <span style="color:brown;">【强制】</span> 对于 <code>trace/debug/info</code> 级别的日志输出，必须进行日志级别的开关判断。</h5><p><span style="color:sienna;">说明：</span> 虽然在 <code>debug(参数)</code>  的方法体内第一行代码 <code>isDisabled(Level.DEBUG_INT)</code> 为真时（<code>Slf4j</code> 的常见实现 <code>Log4j</code> 和 <code>Logback</code>）,就直接 <code>return</code>,但是参数可能会进行字符串拼接运算。此外，如果 <code>debug(getName())</code> 这种参数内有 <code>getName()</code> 方法调用，无谓浪费方法调用的开销。</p>
<p><span style="color:green;">正例：</span> </p>
<figure class="highlight java"><table><tr><td class="gutter"><pre><span class="line">1</span><br><span class="line">2</span><br><span class="line">3</span><br><span class="line">4</span><br></pre></td><td class="code"><pre><span class="line"><span class="comment">// 如果判断为真，那么可以输出 trace 和 debug 级别的日志</span></span><br><span class="line"><span class="keyword">if</span> (logger.isDebugEnabled()) &#123;</span><br><span class="line">    logger.debug(<span class="string">&quot;Current ID is: &#123;&#125; and name is: &#123;&#125;&quot;</span>, id, getName());</span><br><span class="line">&#125;</span><br></pre></td></tr></table></figure>
<h5 id="7-【强制】-避免重复打印日志，浪费磁盘空间，务必在日志配置文件中设置-additivity-false。"><a href="#7-【强制】-避免重复打印日志，浪费磁盘空间，务必在日志配置文件中设置-additivity-false。" class="headerlink" title="7. 【强制】 避免重复打印日志，浪费磁盘空间，务必在日志配置文件中设置 additivity = false。"></a>7. <span style="color:brown;">【强制】</span> 避免重复打印日志，浪费磁盘空间，务必在日志配置文件中设置 <code>additivity = false</code>。</h5><p><span style="color:green;">正例：</span> <code>&lt;logger name=&quot;com.taobao.dubbo.config&quot; additivity=&quot;false&quot;&gt;</code></p>
<h5 id="8-【强制】-生产环境禁止直接使用-System-out-或-System-err-输出日志或使用e-printStackTrace-打印异常堆栈。"><a href="#8-【强制】-生产环境禁止直接使用-System-out-或-System-err-输出日志或使用e-printStackTrace-打印异常堆栈。" class="headerlink" title="8. 【强制】 生产环境禁止直接使用 System.out 或 System.err 输出日志或使用e.printStackTrace() 打印异常堆栈。"></a>8. <span style="color:brown;">【强制】</span> 生产环境禁止直接使用 <code>System.out</code> 或 <code>System.err</code> 输出日志或使用<code>e.printStackTrace()</code> 打印异常堆栈。</h5><p><span style="color:sienna;">说明：</span> 标准日志输出和标准错误输出文件每次 <code>Jboss</code> 重启时才滚动，如果大量输出送出这两个文件，容易造成文件大小超出操作系统大小限制。</p>
<h5 id="9-【强制】-异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字-throws-向上抛出。"><a href="#9-【强制】-异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字-throws-向上抛出。" class="headerlink" title="9. 【强制】 异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字 throws 向上抛出。"></a>9. <span style="color:brown;">【强制】</span> 异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字 <code>throws</code> 向上抛出。</h5><p><span style="color:green;">正例：</span> </p>
<p><code>logger.error(&quot;inputParams: &#123;&#125; and errorMessage: &#123;&#125;&quot;, 各类参数或者对象 toString(), e.getMessage(), e)</code></p>
<h5 id="10-【强制】-日志打印时禁止直接使用-JSON-工具将对象转换为-String。"><a href="#10-【强制】-日志打印时禁止直接使用-JSON-工具将对象转换为-String。" class="headerlink" title="10. 【强制】 日志打印时禁止直接使用 JSON 工具将对象转换为 String。"></a>10. <span style="color:brown;">【强制】</span> 日志打印时禁止直接使用 <code>JSON</code> 工具将对象转换为 <code>String</code>。</h5><p><span style="color:sienna;">说明：</span> 如果对象里某些 <code>get</code> 方法被覆写，存在抛出异常的情况，则可能会因为打印日志而影响正常业务流程的执行。</p>
<p><span style="color:green;">正例：</span> 打印日志仅打印出业务相关属性值或者调用其对象的 <code>toString()</code> 方法。</p>
<h5 id="11-【推荐】-谨慎的记录日志。生产环境禁止输出-debug-日志；有选择地输出-info-日志；如果使用-warn-来记录刚上线的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。"><a href="#11-【推荐】-谨慎的记录日志。生产环境禁止输出-debug-日志；有选择地输出-info-日志；如果使用-warn-来记录刚上线的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。" class="headerlink" title="11. 【推荐】 谨慎的记录日志。生产环境禁止输出 debug 日志；有选择地输出 info 日志；如果使用 warn 来记录刚上线的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。"></a>11. <span style="color:orange;">【推荐】</span> 谨慎的记录日志。生产环境禁止输出 <code>debug</code> 日志；有选择地输出 <code>info</code> 日志；如果使用 <code>warn</code> 来记录刚上线的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。</h5><p><span style="color:sienna;">说明：</span> 大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。记录日志时请思考：这些日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？</p>
<h5 id="12-【推荐】-可以使用-warn-日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。如非必要，请不要在此场景打出-error-日志，避免频繁报警。"><a href="#12-【推荐】-可以使用-warn-日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。如非必要，请不要在此场景打出-error-日志，避免频繁报警。" class="headerlink" title="12. 【推荐】 可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。如非必要，请不要在此场景打出 error 日志，避免频繁报警。"></a>12. <span style="color:orange;">【推荐】</span> 可以使用 <code>warn</code> 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。如非必要，请不要在此场景打出 <code>error</code> 日志，避免频繁报警。</h5><p><span style="color:sienna;">说明：</span> 注意日志输出的级别，<code>error</code> 级别只记录系统逻辑出错、异常或重要的错误信息。</p>
<h5 id="13-【推荐】-尽量用英文来描述日志错误信息，如果日志中的错误信息用英文描述不清楚的话使用中文描述即可，否则容易产生歧义。"><a href="#13-【推荐】-尽量用英文来描述日志错误信息，如果日志中的错误信息用英文描述不清楚的话使用中文描述即可，否则容易产生歧义。" class="headerlink" title="13. 【推荐】 尽量用英文来描述日志错误信息，如果日志中的错误信息用英文描述不清楚的话使用中文描述即可，否则容易产生歧义。"></a>13. <span style="color:orange;">【推荐】</span> 尽量用英文来描述日志错误信息，如果日志中的错误信息用英文描述不清楚的话使用中文描述即可，否则容易产生歧义。</h5><p><span style="color:sienna;">说明：</span> 国际化团队或海外部署的服务器由于字符集问题，使用全英文来注释和描述日志错误信息。</p>

    </div>

    
    
    
        

  <div class="followme">
    <p>欢迎关注我的其它发布渠道</p>

    <div class="social-list">

        <div class="social-item">
          <a target="_blank" class="social-link" href="/atom.xml">
            <span class="icon">
              <i class="fa fa-rss"></i>
            </span>

            <span class="label">RSS</span>
          </a>
        </div>
    </div>
  </div>


      <footer class="post-footer">
          <div class="post-tags">
              <a href="/tags/java/" rel="tag"># java</a>
          </div>

        


        
    <div class="post-nav">
      <div class="post-nav-item">
    <a href="/2021/01/20/%E4%B8%89%E4%B8%AA%E6%95%B0%E7%9A%84%E6%9C%80%E5%A4%A7%E4%B9%98%E7%A7%AF-%E5%8A%9B%E6%89%A3/" rel="prev" title="三个数的最大乘积-力扣">
      <i class="fa fa-chevron-left"></i> 三个数的最大乘积-力扣
    </a></div>
      <div class="post-nav-item">
    <a href="/2021/01/27/%E5%8A%9B%E6%89%A3-%E6%8A%8A%E6%95%B0%E7%BB%84%E6%8E%92%E6%88%90%E6%9C%80%E5%B0%8F%E7%9A%84%E6%95%B0/" rel="next" title="力扣-把数组排成最小的数">
      力扣-把数组排成最小的数 <i class="fa fa-chevron-right"></i>
    </a></div>
    </div>
      </footer>
    
  </article>
  
  
  



          </div>
          

<script>
  window.addEventListener('tabs:register', () => {
    let { activeClass } = CONFIG.comments;
    if (CONFIG.comments.storage) {
      activeClass = localStorage.getItem('comments_active') || activeClass;
    }
    if (activeClass) {
      let activeTab = document.querySelector(`a[href="#comment-${activeClass}"]`);
      if (activeTab) {
        activeTab.click();
      }
    }
  });
  if (CONFIG.comments.storage) {
    window.addEventListener('tabs:click', event => {
      if (!event.target.matches('.tabs-comment .tab-content .tab-pane')) return;
      let commentClass = event.target.classList[1];
      localStorage.setItem('comments_active', commentClass);
    });
  }
</script>

        </div>
          
  
  <div class="toggle sidebar-toggle">
    <span class="toggle-line toggle-line-first"></span>
    <span class="toggle-line toggle-line-middle"></span>
    <span class="toggle-line toggle-line-last"></span>
  </div>

  <aside class="sidebar">
    <div class="sidebar-inner">

      <ul class="sidebar-nav motion-element">
        <li class="sidebar-nav-toc">
          文章目录
        </li>
        <li class="sidebar-nav-overview">
          站点概览
        </li>
      </ul>

      <!--noindex-->
      <div class="post-toc-wrap sidebar-panel">
          <div class="post-toc motion-element"><ol class="nav"><li class="nav-item nav-level-4"><a class="nav-link" href="#%E9%94%99%E8%AF%AF%E7%A0%81"><span class="nav-number">1.</span> <span class="nav-text">错误码</span></a><ol class="nav-child"><li class="nav-item nav-level-5"><a class="nav-link" href="#1-%E3%80%90%E5%BC%BA%E5%88%B6%E3%80%91-%E9%94%99%E8%AF%AF%E7%A0%81%E7%9A%84%E5%88%B6%E5%AE%9A%E5%8E%9F%E5%88%99%EF%BC%9A%E5%BF%AB%E9%80%9F%E6%BA%AF%E6%BA%90%E3%80%81%E6%B2%9F%E9%80%9A%E6%A0%87%E5%87%86%E5%8C%96%E3%80%82"><span class="nav-number">1.1.</span> <span class="nav-text">1. 【强制】 错误码的制定原则：快速溯源、沟通标准化。</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#2-%E3%80%90%E5%BC%BA%E5%88%B6%E3%80%91-%E9%94%99%E8%AF%AF%E7%A0%81%E4%B8%8D%E4%BD%93%E7%8E%B0%E7%89%88%E6%9C%AC%E5%8F%B7%E5%92%8C%E9%94%99%E8%AF%AF%E7%AD%89%E7%BA%A7%E4%BF%A1%E6%81%AF%E3%80%82"><span class="nav-number">1.2.</span> <span class="nav-text">2. 【强制】 错误码不体现版本号和错误等级信息。</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#3-%E3%80%90%E5%BC%BA%E5%88%B6%E3%80%91-%E5%85%A8%E9%83%A8%E6%AD%A3%E5%B8%B8%EF%BC%8C%E4%BD%86%E4%B8%8D%E5%BE%97%E4%B8%8D%E5%A1%AB%E5%85%85%E9%94%99%E8%AF%AF%E7%A0%81%E6%97%B6%E8%BF%94%E5%9B%9E%E4%BA%94%E4%B8%AA%E9%9B%B6%EF%BC%9A00000%E3%80%82"><span class="nav-number">1.3.</span> <span class="nav-text">3. 【强制】 全部正常，但不得不填充错误码时返回五个零：00000。</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#4-%E3%80%90%E5%BC%BA%E5%88%B6%E3%80%91-%E9%94%99%E8%AF%AF%E7%A0%81%E4%B8%BA%E5%AD%97%E7%AC%A6%E4%B8%B2%E7%B1%BB%E5%9E%8B%EF%BC%8C%E5%85%B1-5-%E4%BD%8D%EF%BC%8C%E5%88%86%E6%88%90%E4%B8%A4%E4%B8%AA%E9%83%A8%E5%88%86%EF%BC%9A%E9%94%99%E8%AF%AF%E4%BA%A7%E7%94%9F%E6%9D%A5%E6%BA%90-%E5%9B%9B%E4%BD%8D%E6%95%B0%E5%AD%97%E7%BC%96%E5%8F%B7%E3%80%82"><span class="nav-number">1.4.</span> <span class="nav-text">4. 【强制】 错误码为字符串类型，共 5 位，分成两个部分：错误产生来源 + 四位数字编号。</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#5-%E3%80%90%E5%BC%BA%E5%88%B6%E3%80%91-%E7%BC%96%E5%8F%B7%E4%B8%8D%E4%B8%8E%E5%85%AC%E5%8F%B8%E4%B8%9A%E5%8A%A1%E6%9E%B6%E6%9E%84%EF%BC%8C%E6%9B%B4%E4%B8%8D%E4%B8%8E%E7%BB%84%E7%BB%87%E6%9E%B6%E6%9E%84%E6%8C%82%E9%92%A9%EF%BC%8C%E4%BB%A5%E5%85%88%E5%88%B0%E5%85%88%E5%BE%97%E7%9A%84%E5%8E%9F%E5%88%99%E5%9C%A8%E7%BB%9F%E4%B8%80%E5%B9%B3%E5%8F%B0%E4%B8%8A%E8%BF%9B%E8%A1%8C%EF%BC%8C%E5%AE%A1%E6%89%B9%E7%94%9F%E6%95%88%EF%BC%8C%E7%BC%96%E5%8F%B7%E5%8D%B3%E8%A2%AB%E6%B0%B8%E4%B9%85%E5%9B%BA%E5%AE%9A%E3%80%82"><span class="nav-number">1.5.</span> <span class="nav-text">5. 【强制】 编号不与公司业务架构，更不与组织架构挂钩，以先到先得的原则在统一平台上进行，审批生效，编号即被永久固定。</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#6-%E3%80%90%E5%BC%BA%E5%88%B6%E3%80%91-%E9%94%99%E8%AF%AF%E7%A0%81%E4%BD%BF%E7%94%A8%E8%80%85%E9%81%BF%E5%85%8D%E9%9A%8F%E6%84%8F%E5%AE%9A%E4%B9%89%E6%96%B0%E7%9A%84%E9%94%99%E8%AF%AF%E7%A0%81%E3%80%82"><span class="nav-number">1.6.</span> <span class="nav-text">6. 【强制】 错误码使用者避免随意定义新的错误码。</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#7-%E3%80%90%E5%BC%BA%E5%88%B6%E3%80%91-%E9%94%99%E8%AF%AF%E7%A0%81%E4%B8%8D%E8%83%BD%E7%9B%B4%E6%8E%A5%E8%BE%93%E5%87%BA%E7%BB%99%E7%94%A8%E6%88%B7%E4%BD%9C%E4%B8%BA%E6%8F%90%E7%A4%BA%E4%BF%A1%E6%81%AF%E4%BD%BF%E7%94%A8%E3%80%82"><span class="nav-number">1.7.</span> <span class="nav-text">7. 【强制】 错误码不能直接输出给用户作为提示信息使用。</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#8-%E3%80%90%E6%8E%A8%E8%8D%90%E3%80%91-%E9%94%99%E8%AF%AF%E7%A0%81%E4%B9%8B%E5%A4%96%E7%9A%84%E4%B8%9A%E5%8A%A1%E7%8B%AC%E7%89%B9%E4%BF%A1%E6%81%AF%E7%94%B1error-message-%E6%9D%A5%E6%89%BF%E8%BD%BD%EF%BC%8C%E8%80%8C%E4%B8%8D%E6%98%AF%E8%AE%A9%E9%94%99%E8%AF%AF%E6%9C%AC%E8%BA%AB%E6%B6%B5%E7%9B%96%E8%BF%87%E5%A4%9A%E5%85%B7%E4%BD%93%E4%B8%9A%E5%8A%A1%E5%B1%9E%E6%80%A7%E3%80%82"><span class="nav-number">1.8.</span> <span class="nav-text">8. 【推荐】 错误码之外的业务独特信息由error_message 来承载，而不是让错误本身涵盖过多具体业务属性。</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#9-%E3%80%90%E6%8E%A8%E8%8D%90%E3%80%91-%E5%9C%A8%E8%8E%B7%E5%8F%96%E7%AC%AC%E4%B8%89%E6%96%B9%E6%9C%8D%E5%8A%A1%E9%94%99%E8%AF%AF%E6%97%B6%EF%BC%8C%E5%90%91%E4%B8%8A%E6%8A%9B%E5%87%BA%E5%85%81%E8%AE%B8%E6%9C%AC%E7%B3%BB%E7%BB%9F%E8%BD%AC%E4%B9%89%EF%BC%8C%E7%94%B1-C-%E8%BD%AC%E4%B8%BA-B%EF%BC%8C%E5%B9%B6%E4%B8%94%E5%9C%A8%E9%94%99%E8%AF%AF%E4%BF%A1%E6%81%AF%E4%B8%8A%E5%B8%A6%E4%B8%8A%E5%8E%9F%E6%9C%89%E7%9A%84%E7%AC%AC%E4%B8%89%E6%96%B9%E9%94%99%E8%AF%AF%E7%A0%81%E3%80%82"><span class="nav-number">1.9.</span> <span class="nav-text">9. 【推荐】 在获取第三方服务错误时，向上抛出允许本系统转义，由 C 转为 B，并且在错误信息上带上原有的第三方错误码。</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#10-%E3%80%90%E5%8F%82%E8%80%83%E3%80%91-%E9%94%99%E8%AF%AF%E7%A0%81%E5%88%86%E4%B8%BA%E4%B8%80%E7%BA%A7%E5%AE%8F%E8%A7%82%E9%94%99%E8%AF%AF%E7%A0%81%E3%80%81%E4%BA%8C%E7%BA%A7%E5%AE%8F%E8%A7%82%E9%94%99%E8%AF%AF%E7%A0%81%E3%80%81%E4%B8%89%E7%BA%A7%E5%AE%8F%E8%A7%82%E9%94%99%E8%AF%AF%E7%A0%81%E3%80%82"><span class="nav-number">1.10.</span> <span class="nav-text">10. 【参考】 错误码分为一级宏观错误码、二级宏观错误码、三级宏观错误码。</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#11-%E3%80%90%E5%8F%82%E8%80%83%E3%80%91-%E9%94%99%E8%AF%AF%E7%A0%81%E7%9A%84%E5%90%8E%E4%B8%89%E4%BD%8D%E7%BC%96%E7%A0%81%E4%B8%8E-HTTP-%E7%8A%B6%E6%80%81%E7%A0%81%E6%B2%A1%E6%9C%89%E4%BB%BB%E4%BD%95%E5%85%B3%E7%B3%BB%E3%80%82"><span class="nav-number">1.11.</span> <span class="nav-text">11. 【参考】 错误码的后三位编码与 HTTP 状态码没有任何关系。</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#12-%E3%80%90%E5%8F%82%E8%80%83%E3%80%91-%E9%94%99%E8%AF%AF%E7%A0%81%E6%9C%89%E5%88%A9%E4%BA%8E%E4%B8%8D%E5%90%8C%E6%96%87%E5%8C%96%E8%83%8C%E6%99%AF%E7%9A%84%E5%BC%80%E5%8F%91%E8%80%85%E8%BF%9B%E8%A1%8C%E4%BA%A4%E6%B5%81%E4%B8%8E%E4%BB%A3%E7%A0%81%E5%8D%8F%E4%BD%9C%E3%80%82"><span class="nav-number">1.12.</span> <span class="nav-text">12. 【参考】 错误码有利于不同文化背景的开发者进行交流与代码协作。</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#13-%E3%80%90%E5%8F%82%E8%80%83%E3%80%91-%E9%94%99%E8%AF%AF%E7%A0%81%E5%8D%B3%E4%BA%BA%E6%80%A7%EF%BC%8C%E6%84%9F%E6%80%A7%E8%AE%A4%E7%9F%A5-%E5%8F%A3%E5%8F%A3%E7%9B%B8%E4%BC%A0%EF%BC%8C%E4%BD%BF%E7%94%A8%E7%BA%AF%E6%95%B0%E5%AD%97%E6%9D%A5%E8%BF%9B%E8%A1%8C%E9%94%99%E8%AF%AF%E7%A0%81%E7%BC%96%E6%8E%92%E4%B8%8D%E5%88%A9%E4%BA%8E%E6%84%9F%E6%80%A7%E8%AE%B0%E5%BF%86%E5%92%8C%E5%88%86%E7%B1%BB%E3%80%82"><span class="nav-number">1.13.</span> <span class="nav-text">13. 【参考】 错误码即人性，感性认知 + 口口相传，使用纯数字来进行错误码编排不利于感性记忆和分类。</span></a></li></ol></li><li class="nav-item nav-level-4"><a class="nav-link" href="#%E6%97%A5%E5%BF%97%E8%A7%84%E7%BA%A6"><span class="nav-number">2.</span> <span class="nav-text">日志规约</span></a><ol class="nav-child"><li class="nav-item nav-level-5"><a class="nav-link" href="#1-%E3%80%90%E5%BC%BA%E5%88%B6%E3%80%91-%E5%BA%94%E7%94%A8%E4%B8%AD%E4%B8%8D%E5%8F%AF%E7%9B%B4%E6%8E%A5%E4%BD%BF%E7%94%A8%E6%97%A5%E5%BF%97%E7%B3%BB%E7%BB%9F%EF%BC%88Log4j%E3%80%81Logback%EF%BC%89%E4%B8%AD%E7%9A%84-API%EF%BC%8C%E8%80%8C%E5%BA%94%E4%BE%9D%E8%B5%96%E4%BD%BF%E7%94%A8%E6%97%A5%E5%BF%97%E6%A1%86%E6%9E%B6%EF%BC%88SLF4J%E3%80%81JCL%E2%80%94Jakarta-Commons-Logging%EF%BC%89%E4%B8%AD%E7%9A%84-API%EF%BC%8C%E4%BD%BF%E7%94%A8%E9%97%A8%E9%9D%A2%E6%A8%A1%E5%BC%8F%E7%9A%84%E6%97%A5%E5%BF%97%E6%A1%86%E6%9E%B6%EF%BC%8C%E6%9C%89%E5%88%A9%E4%BA%8E%E7%BB%B4%E6%8A%A4%E5%92%8C%E5%90%84%E4%B8%AA%E7%B1%BB%E7%9A%84%E6%97%A5%E5%BF%97%E5%A4%84%E7%90%86%E6%96%B9%E5%BC%8F%E7%BB%9F%E4%B8%80%E3%80%82"><span class="nav-number">2.1.</span> <span class="nav-text">1. 【强制】 应用中不可直接使用日志系统（Log4j、Logback）中的 API，而应依赖使用日志框架（SLF4J、JCL—Jakarta Commons Logging）中的 API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#2-%E3%80%90%E5%BC%BA%E5%88%B6%E3%80%91-%E6%89%80%E6%9C%89%E6%97%A5%E5%BF%97%E6%96%87%E4%BB%B6%E8%87%B3%E5%B0%91%E4%BF%9D%E5%AD%98-15-%E5%A4%A9%EF%BC%8C%E5%9B%A0%E4%B8%BA%E6%9C%89%E4%BA%9B%E5%BC%82%E5%B8%B8%E5%85%B7%E5%A4%87%E4%BB%A5-%E5%91%A8-%E4%B8%BA%E9%A2%91%E6%AC%A1%E5%8F%91%E7%94%9F%E7%9A%84%E7%89%B9%E7%82%B9%E3%80%82%E5%AF%B9%E4%BA%8E%E5%BD%93%E5%A4%A9%E6%97%A5%E5%BF%97%EF%BC%8C%E4%BB%A5-%E5%BA%94%E7%94%A8%E5%90%8D-log-%E6%9D%A5%E4%BF%9D%E5%AD%98%EF%BC%8C%E4%BF%9D%E5%AD%98%E5%9C%A8-home-admin-%E5%BA%94%E7%94%A8%E5%90%8D-logs-%E7%9B%AE%E5%BD%95%E4%B8%8B%EF%BC%8C%E8%BF%87%E5%BE%80%E6%97%A5%E5%BF%97%E6%A0%BC%E5%BC%8F%E4%B8%BA-logname-log-%E4%BF%9D%E5%AD%98%E6%97%A5%E6%9C%9F-%EF%BC%8C%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F%EF%BC%9Ayyyy-MM-dd"><span class="nav-number">2.2.</span> <span class="nav-text">2. 【强制】 所有日志文件至少保存 15 天，因为有些异常具备以 周  为频次发生的特点。对于当天日志，以 应用名.log 来保存，保存在 &#x2F;home&#x2F;admin&#x2F;应用名&#x2F;logs&#x2F; 目录下，过往日志格式为: {logname}.log.{保存日期}，日期格式：yyyy-MM-dd</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#3-%E3%80%90%E5%BC%BA%E5%88%B6%E3%80%91-%E6%A0%B9%E6%8D%AE%E5%9B%BD%E5%AE%B6%E6%B3%95%E5%BE%8B%EF%BC%8C%E7%BD%91%E7%BB%9C%E8%BF%90%E8%A1%8C%E7%8A%B6%E6%80%81%E3%80%81%E7%BD%91%E7%BB%9C%E5%AE%89%E5%85%A8%E4%BA%8B%E4%BB%B6%E3%80%81%E4%B8%AA%E4%BA%BA%E6%95%8F%E6%84%9F%E4%BF%A1%E6%81%AF%E6%93%8D%E4%BD%9C%E7%AD%89%E7%9B%B8%E5%85%B3%E8%AE%B0%E5%BD%95%EF%BC%8C%E7%95%99%E5%AD%98%E7%9A%84%E6%97%A5%E5%BF%97%E4%B8%8D%E5%B0%91%E4%BA%8E%E5%85%AD%E4%B8%AA%E6%9C%88%EF%BC%8C%E5%B9%B6%E4%B8%94%E8%BF%9B%E8%A1%8C%E7%BD%91%E7%BB%9C%E5%A4%9A%E6%9C%BA%E5%A4%87%E4%BB%BD%E3%80%82"><span class="nav-number">2.3.</span> <span class="nav-text">3. 【强制】 根据国家法律，网络运行状态、网络安全事件、个人敏感信息操作等相关记录，留存的日志不少于六个月，并且进行网络多机备份。</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#4-%E3%80%90%E5%BC%BA%E5%88%B6%E3%80%91-%E5%BA%94%E7%94%A8%E4%B8%AD%E7%9A%84%E6%89%A9%E5%B1%95%E6%97%A5%E5%BF%97%EF%BC%88%E5%A6%82%E6%89%93%E7%82%B9%E3%80%81%E4%B8%B4%E6%97%B6%E7%9B%91%E6%8E%A7%E3%80%81%E8%AE%BF%E9%97%AE%E6%97%A5%E5%BF%97%E7%AD%89%EF%BC%89%E5%91%BD%E5%90%8D%E6%96%B9%E5%BC%8F%EF%BC%9AappName-logType-logName-log"><span class="nav-number">2.4.</span> <span class="nav-text">4. 【强制】 应用中的扩展日志（如打点、临时监控、访问日志等）命名方式：appName_logType_logName.log.</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#5-%E3%80%90%E5%BC%BA%E5%88%B6%E3%80%91-%E5%9C%A8%E6%97%A5%E5%BF%97%E8%BE%93%E5%87%BA%E6%97%B6%EF%BC%8C%E5%AD%97%E7%AC%A6%E4%B8%B2%E5%8F%98%E9%87%8F%E4%B9%8B%E9%97%B4%E7%9A%84%E6%8B%BC%E6%8E%A5%E4%BD%BF%E7%94%A8%E5%8D%A0%E4%BD%8D%E7%AC%A6%E7%9A%84%E6%96%B9%E5%BC%8F%E3%80%82"><span class="nav-number">2.5.</span> <span class="nav-text">5. 【强制】 在日志输出时，字符串变量之间的拼接使用占位符的方式。</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#6-%E3%80%90%E5%BC%BA%E5%88%B6%E3%80%91-%E5%AF%B9%E4%BA%8E-trace-debug-info-%E7%BA%A7%E5%88%AB%E7%9A%84%E6%97%A5%E5%BF%97%E8%BE%93%E5%87%BA%EF%BC%8C%E5%BF%85%E9%A1%BB%E8%BF%9B%E8%A1%8C%E6%97%A5%E5%BF%97%E7%BA%A7%E5%88%AB%E7%9A%84%E5%BC%80%E5%85%B3%E5%88%A4%E6%96%AD%E3%80%82"><span class="nav-number">2.6.</span> <span class="nav-text">6. 【强制】 对于 trace&#x2F;debug&#x2F;info 级别的日志输出，必须进行日志级别的开关判断。</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#7-%E3%80%90%E5%BC%BA%E5%88%B6%E3%80%91-%E9%81%BF%E5%85%8D%E9%87%8D%E5%A4%8D%E6%89%93%E5%8D%B0%E6%97%A5%E5%BF%97%EF%BC%8C%E6%B5%AA%E8%B4%B9%E7%A3%81%E7%9B%98%E7%A9%BA%E9%97%B4%EF%BC%8C%E5%8A%A1%E5%BF%85%E5%9C%A8%E6%97%A5%E5%BF%97%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6%E4%B8%AD%E8%AE%BE%E7%BD%AE-additivity-false%E3%80%82"><span class="nav-number">2.7.</span> <span class="nav-text">7. 【强制】 避免重复打印日志，浪费磁盘空间，务必在日志配置文件中设置 additivity &#x3D; false。</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#8-%E3%80%90%E5%BC%BA%E5%88%B6%E3%80%91-%E7%94%9F%E4%BA%A7%E7%8E%AF%E5%A2%83%E7%A6%81%E6%AD%A2%E7%9B%B4%E6%8E%A5%E4%BD%BF%E7%94%A8-System-out-%E6%88%96-System-err-%E8%BE%93%E5%87%BA%E6%97%A5%E5%BF%97%E6%88%96%E4%BD%BF%E7%94%A8e-printStackTrace-%E6%89%93%E5%8D%B0%E5%BC%82%E5%B8%B8%E5%A0%86%E6%A0%88%E3%80%82"><span class="nav-number">2.8.</span> <span class="nav-text">8. 【强制】 生产环境禁止直接使用 System.out 或 System.err 输出日志或使用e.printStackTrace() 打印异常堆栈。</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#9-%E3%80%90%E5%BC%BA%E5%88%B6%E3%80%91-%E5%BC%82%E5%B8%B8%E4%BF%A1%E6%81%AF%E5%BA%94%E8%AF%A5%E5%8C%85%E6%8B%AC%E4%B8%A4%E7%B1%BB%E4%BF%A1%E6%81%AF%EF%BC%9A%E6%A1%88%E5%8F%91%E7%8E%B0%E5%9C%BA%E4%BF%A1%E6%81%AF%E5%92%8C%E5%BC%82%E5%B8%B8%E5%A0%86%E6%A0%88%E4%BF%A1%E6%81%AF%E3%80%82%E5%A6%82%E6%9E%9C%E4%B8%8D%E5%A4%84%E7%90%86%EF%BC%8C%E9%82%A3%E4%B9%88%E9%80%9A%E8%BF%87%E5%85%B3%E9%94%AE%E5%AD%97-throws-%E5%90%91%E4%B8%8A%E6%8A%9B%E5%87%BA%E3%80%82"><span class="nav-number">2.9.</span> <span class="nav-text">9. 【强制】 异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字 throws 向上抛出。</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#10-%E3%80%90%E5%BC%BA%E5%88%B6%E3%80%91-%E6%97%A5%E5%BF%97%E6%89%93%E5%8D%B0%E6%97%B6%E7%A6%81%E6%AD%A2%E7%9B%B4%E6%8E%A5%E4%BD%BF%E7%94%A8-JSON-%E5%B7%A5%E5%85%B7%E5%B0%86%E5%AF%B9%E8%B1%A1%E8%BD%AC%E6%8D%A2%E4%B8%BA-String%E3%80%82"><span class="nav-number">2.10.</span> <span class="nav-text">10. 【强制】 日志打印时禁止直接使用 JSON 工具将对象转换为 String。</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#11-%E3%80%90%E6%8E%A8%E8%8D%90%E3%80%91-%E8%B0%A8%E6%85%8E%E7%9A%84%E8%AE%B0%E5%BD%95%E6%97%A5%E5%BF%97%E3%80%82%E7%94%9F%E4%BA%A7%E7%8E%AF%E5%A2%83%E7%A6%81%E6%AD%A2%E8%BE%93%E5%87%BA-debug-%E6%97%A5%E5%BF%97%EF%BC%9B%E6%9C%89%E9%80%89%E6%8B%A9%E5%9C%B0%E8%BE%93%E5%87%BA-info-%E6%97%A5%E5%BF%97%EF%BC%9B%E5%A6%82%E6%9E%9C%E4%BD%BF%E7%94%A8-warn-%E6%9D%A5%E8%AE%B0%E5%BD%95%E5%88%9A%E4%B8%8A%E7%BA%BF%E7%9A%84%E4%B8%9A%E5%8A%A1%E8%A1%8C%E4%B8%BA%E4%BF%A1%E6%81%AF%EF%BC%8C%E4%B8%80%E5%AE%9A%E8%A6%81%E6%B3%A8%E6%84%8F%E6%97%A5%E5%BF%97%E8%BE%93%E5%87%BA%E9%87%8F%E7%9A%84%E9%97%AE%E9%A2%98%EF%BC%8C%E9%81%BF%E5%85%8D%E6%8A%8A%E6%9C%8D%E5%8A%A1%E5%99%A8%E7%A3%81%E7%9B%98%E6%92%91%E7%88%86%EF%BC%8C%E5%B9%B6%E8%AE%B0%E5%BE%97%E5%8F%8A%E6%97%B6%E5%88%A0%E9%99%A4%E8%BF%99%E4%BA%9B%E8%A7%82%E5%AF%9F%E6%97%A5%E5%BF%97%E3%80%82"><span class="nav-number">2.11.</span> <span class="nav-text">11. 【推荐】 谨慎的记录日志。生产环境禁止输出 debug 日志；有选择地输出 info 日志；如果使用 warn 来记录刚上线的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#12-%E3%80%90%E6%8E%A8%E8%8D%90%E3%80%91-%E5%8F%AF%E4%BB%A5%E4%BD%BF%E7%94%A8-warn-%E6%97%A5%E5%BF%97%E7%BA%A7%E5%88%AB%E6%9D%A5%E8%AE%B0%E5%BD%95%E7%94%A8%E6%88%B7%E8%BE%93%E5%85%A5%E5%8F%82%E6%95%B0%E9%94%99%E8%AF%AF%E7%9A%84%E6%83%85%E5%86%B5%EF%BC%8C%E9%81%BF%E5%85%8D%E7%94%A8%E6%88%B7%E6%8A%95%E8%AF%89%E6%97%B6%EF%BC%8C%E6%97%A0%E6%89%80%E9%80%82%E4%BB%8E%E3%80%82%E5%A6%82%E9%9D%9E%E5%BF%85%E8%A6%81%EF%BC%8C%E8%AF%B7%E4%B8%8D%E8%A6%81%E5%9C%A8%E6%AD%A4%E5%9C%BA%E6%99%AF%E6%89%93%E5%87%BA-error-%E6%97%A5%E5%BF%97%EF%BC%8C%E9%81%BF%E5%85%8D%E9%A2%91%E7%B9%81%E6%8A%A5%E8%AD%A6%E3%80%82"><span class="nav-number">2.12.</span> <span class="nav-text">12. 【推荐】 可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。如非必要，请不要在此场景打出 error 日志，避免频繁报警。</span></a></li><li class="nav-item nav-level-5"><a class="nav-link" href="#13-%E3%80%90%E6%8E%A8%E8%8D%90%E3%80%91-%E5%B0%BD%E9%87%8F%E7%94%A8%E8%8B%B1%E6%96%87%E6%9D%A5%E6%8F%8F%E8%BF%B0%E6%97%A5%E5%BF%97%E9%94%99%E8%AF%AF%E4%BF%A1%E6%81%AF%EF%BC%8C%E5%A6%82%E6%9E%9C%E6%97%A5%E5%BF%97%E4%B8%AD%E7%9A%84%E9%94%99%E8%AF%AF%E4%BF%A1%E6%81%AF%E7%94%A8%E8%8B%B1%E6%96%87%E6%8F%8F%E8%BF%B0%E4%B8%8D%E6%B8%85%E6%A5%9A%E7%9A%84%E8%AF%9D%E4%BD%BF%E7%94%A8%E4%B8%AD%E6%96%87%E6%8F%8F%E8%BF%B0%E5%8D%B3%E5%8F%AF%EF%BC%8C%E5%90%A6%E5%88%99%E5%AE%B9%E6%98%93%E4%BA%A7%E7%94%9F%E6%AD%A7%E4%B9%89%E3%80%82"><span class="nav-number">2.13.</span> <span class="nav-text">13. 【推荐】 尽量用英文来描述日志错误信息，如果日志中的错误信息用英文描述不清楚的话使用中文描述即可，否则容易产生歧义。</span></a></li></ol></li></ol></div>
      </div>
      <!--/noindex-->

      <div class="site-overview-wrap sidebar-panel">
        <div class="site-author motion-element" itemprop="author" itemscope itemtype="http://schema.org/Person">
  <p class="site-author-name" itemprop="name">田园隐士</p>
  <div class="site-description" itemprop="description">talk is cheap, show me the code</div>
</div>
<div class="site-state-wrap motion-element">
  <nav class="site-state">
      <div class="site-state-item site-state-posts">
          <a href="/archives/">
        
          <span class="site-state-item-count">347</span>
          <span class="site-state-item-name">日志</span>
        </a>
      </div>
      <div class="site-state-item site-state-categories">
            <a href="/categories/">
        <span class="site-state-item-count">53</span>
        <span class="site-state-item-name">分类</span></a>
      </div>
      <div class="site-state-item site-state-tags">
            <a href="/tags/">
        <span class="site-state-item-count">115</span>
        <span class="site-state-item-name">标签</span></a>
      </div>
  </nav>
</div>



      </div>

    </div>
  </aside>
  <div id="sidebar-dimmer"></div>


      </div>
    </main>

    <footer class="footer">
      <div class="footer-inner">
        

        

<div class="copyright">
  
  &copy; 
  <span itemprop="copyrightYear">2022</span>
  <span class="with-love">
    <i class="fa fa-heart"></i>
  </span>
  <span class="author" itemprop="copyrightHolder">田园隐士</span>
    <span class="post-meta-divider">|</span>
    <span class="post-meta-item-icon">
      <i class="fa fa-chart-area"></i>
    </span>
    <span title="站点总字数">587k</span>
    <span class="post-meta-divider">|</span>
    <span class="post-meta-item-icon">
      <i class="fa fa-coffee"></i>
    </span>
    <span title="站点阅读时长">8:53</span>
</div>
  <div class="powered-by">由 <a href="https://hexo.io/" class="theme-link" rel="noopener" target="_blank">Hexo</a> & <a href="https://muse.theme-next.org/" class="theme-link" rel="noopener" target="_blank">NexT.Muse</a> 强力驱动
  </div>

        
<div class="busuanzi-count">
  <script async src="https://busuanzi.ibruce.info/busuanzi/2.3/busuanzi.pure.mini.js"></script>
    <span class="post-meta-item" id="busuanzi_container_site_uv" style="display: none;">
      <span class="post-meta-item-icon">
        <i class="fa fa-user"></i>
      </span>
      <span class="site-uv" title="总访客量">
        <span id="busuanzi_value_site_uv"></span>
      </span>
    </span>
    <span class="post-meta-divider">|</span>
    <span class="post-meta-item" id="busuanzi_container_site_pv" style="display: none;">
      <span class="post-meta-item-icon">
        <i class="fa fa-eye"></i>
      </span>
      <span class="site-pv" title="总访问量">
        <span id="busuanzi_value_site_pv"></span>
      </span>
    </span>
</div>








      </div>
    </footer>
  </div>

  
  <script src="/lib/anime.min.js"></script>
  <script src="/lib/velocity/velocity.min.js"></script>
  <script src="/lib/velocity/velocity.ui.min.js"></script>

<script src="/js/utils.js"></script>

<script src="/js/motion.js"></script>


<script src="/js/schemes/muse.js"></script>


<script src="/js/next-boot.js"></script>




  




  
<script src="/js/local-search.js"></script>













  

  

  

</body>
</html>
